====== gitlabapi Plugin ======

---- plugin ----
description: GitLab-Api displays some information from a GitLab project.
author     : mozgan 
email      : mozgan@gmail.com 
type       : syntax
lastupdate : 2023-01-19
compatible : Igor
depends    : 
conflicts  : 
similar    : 
tags       : git, gitlab, projects, code

downloadurl: http://github.com/mozgan/dokuwiki-plugin-gitlabapi/zipball/master
bugtracker : http://github.com/mozgan/dokuwiki-plugin-gitlabapi/issues
sourcerepo : http://github.com/mozgan/dokuwiki-plugin-gitlabapi/
donationurl: 

screenshot_img : https://raw.githubusercontent.com/mozgan/dokuwiki-plugin-gitlabapi/main/images/gitlab.png
----

//:!: This plugis is an extended version of [[plugin:gitlabproject|Gitlab-Project]]. All thanks to [[https://github.com/algorys|algorys]].//

===== Installation =====

Search and install the plugin using the [[plugin:extension|Extension Manager]]. 

===== Configuration =====

The following values must be configured in the Configuration Manager:

  * **server.default**: Set your default GitLab url without slash ending. You can override this setting in ''server.json'' file.
  * **token.default**: Fill your admin token. You can override this setting in ''server.json'' file.

===== Syntax =====

==== Default Syntax ====

<code php>
<gitlab-api project-path="<NAMESPACE>/<SUB_DIRS>/<PROJECT_NAME>" />
</code>

  * **NAMESPACE** is the namespace of your project.
  * **SUB_DIRS** is the sub-directories of your project if exists.
  * **PROJECT_NAME** is the name of your project.

For instance, if your project is available at ''http://gitlab.domain.com/ns/dir1/dir2/project'', then the syntax should be:

<code php>
<gitlab-api project-path="ns/dir1/dir2/project" />
</code>


==== Display Information ====

The plugin displays following information:

  * **milestones="n"** lists the latest **n** milestones.
  * **commits="n"** lists the latest **n** commits.
  * **issues="n"** lists the latest **n** issues.
  * **pipelines="n"** lists the latest **n** pipelines.

For instance, if you want to see the latest 3 milestones, 10 commits, 5 issues, and 10 pipelines, then the syntax will be:

<code php>
<gitlab-api project-path="ns/dir/project" commits="10" issues="5" milestones="3" pipelines="10" />
</code>

==== Override Server and Token ====

There a JSON file ''server.json'' inside the root of plugin. You can add or change the servers and their tokens.

For instance; you have a GitLab server namely ''gitlab.home'' and following JSON file:

<code php>
{
  "gitlab.home": {
    "url": "http://192.168.0.10",
    "token": "aabbccddeeffgghh"
  }
}
</code>

Then you can use ''server'' parameter as follows:

<code php>
<gitlab-api server="gitlab.home" project-path="ns/project" />
</code>

=== Change Log ===

{{rss>https://github.com/mozgan/dokuwiki-plugin-gitlabapi/commits/main.atom 5 author date}}

=== Known Bugs and Issues ===

Please report youe issues or your idea at [[https://github.com/mozgan/dokuwiki-plugin-gitlabapi/issues|GitLab-Api]].